core/androidx.core.app/[main]NotificationCompat/Builder

Builder

open class Builder(source)

Builder class for NotificationCompat objects. Allows easier control over all the flags, as well as help constructing the typical notification layouts.

On platform versions that don't offer expanded notifications, methods that depend on expanded notifications have no effect.

For example, action buttons won't appear on platforms prior to Android 4.1. Action buttons depend on expanded notifications, which are only available in Android 4.1 and later.

For this reason, you should always ensure that UI controls in a notification are also available in an android.app.Activity in your app, and you should always start that android.app.Activity when users click the notification. To do this, use the setContentIntent() method.

Constructors

constructor(@NonNull context: Context, @NonNull notification: Notification)

Creates a NotificationCompat.Builder which can be used to build a notification that is equivalent to the given one, such that updates can be made to an existing notification with the NotificationCompat.Builder API.

constructor(@NonNull context: Context, @NonNull channelId: String)

Constructor.

constructor(@NonNull context: Context)

Properties

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open var mActions: ArrayList<NotificationCompat.Action>

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open var mContext: Context

open var ~~mPeople~~: ArrayList<String>

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open var mPersonList: ArrayList<Person>

Functions

open fun addAction(@Nullable action: NotificationCompat.Action): NotificationCompat.Builder

open fun addAction(icon: Int, @Nullable title: CharSequence, @Nullable intent: PendingIntent): NotificationCompat.Builder

Add an action to this notification.

open fun addExtras(@Nullable extras: Bundle): NotificationCompat.Builder

Merge additional metadata into this notification.

addInvisibleAction

@RequiresApi(value = 21)

open fun addInvisibleAction(@Nullable action: NotificationCompat.Action): NotificationCompat.Builder

@RequiresApi(value = 21)

open fun addInvisibleAction(icon: Int, @Nullable title: CharSequence, @Nullable intent: PendingIntent): NotificationCompat.Builder

Add an invisible action to this notification.

open fun addPerson(@Nullable person: Person): NotificationCompat.Builder

open fun ~~addPerson~~(@Nullable uri: String): NotificationCompat.Builder

Add a person that is relevant to this notification.

open fun build(): Notification

Combine all of the options that have been set and return a new Notification object.

open fun clearActions(): NotificationCompat.Builder

Clear any actions added via addAction

clearInvisibleActions

open fun clearInvisibleActions(): NotificationCompat.Builder

Clear any invisible actions added via addInvisibleAction

open fun clearPeople(): NotificationCompat.Builder

Clear any people added via either addPerson or addPerson

createBigContentView

open fun createBigContentView(): RemoteViews

Construct a RemoteViews for the final big notification layout.

createContentView

open fun createContentView(): RemoteViews

Construct a RemoteViews for the final notification layout.

createHeadsUpContentView

open fun createHeadsUpContentView(): RemoteViews

Construct a RemoteViews for the final heads-up notification layout.

open fun extend(@NonNull extender: NotificationCompat.Extender): NotificationCompat.Builder

Apply an extender to this notification builder.

getBigContentView

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun getBigContentView(): RemoteViews

getBubbleMetadata

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun getBubbleMetadata(): NotificationCompat.BubbleMetadata

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun getColor(): Int

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun getContentView(): RemoteViews

open fun getExtras(): Bundle

Get the current metadata Bundle used by this notification Builder.

getForegroundServiceBehavior

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun getForegroundServiceBehavior(): Int

getHeadsUpContentView

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun getHeadsUpContentView(): RemoteViews

getNotification

open fun ~~getNotification~~(): Notification

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun getPriority(): Int

getWhenIfShowing

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun getWhenIfShowing(): Long

return when if it is showing or 0 otherwise

setAllowSystemGeneratedContextualActions

open fun setAllowSystemGeneratedContextualActions(allowed: Boolean): NotificationCompat.Builder

Determines whether the platform can generate contextual actions for a notification.

open fun setAutoCancel(autoCancel: Boolean): NotificationCompat.Builder

Setting this flag will make it so the notification is automatically canceled when the user clicks it in the panel.

setBadgeIconType

open fun setBadgeIconType(icon: Int): NotificationCompat.Builder

Sets which icon to display as a badge for this notification.

setBubbleMetadata

open fun setBubbleMetadata(@Nullable data: NotificationCompat.BubbleMetadata): NotificationCompat.Builder

Sets the BubbleMetadata that will be used to display app content in a floating window over the existing foreground activity.

open fun setCategory(@Nullable category: String): NotificationCompat.Builder

Set the notification category.

open fun setChannelId(@NonNull channelId: String): NotificationCompat.Builder

Specifies the channel the notification should be delivered on.

setChronometerCountDown

@RequiresApi(value = 24)

open fun setChronometerCountDown(countsDown: Boolean): NotificationCompat.Builder

Sets the Chronometer to count down instead of counting up.

open fun setColor(@ColorInt argb: Int): NotificationCompat.Builder

Sets color.

open fun setColorized(colorize: Boolean): NotificationCompat.Builder

Set whether this notification should be colorized.

open fun setContent(@Nullable views: RemoteViews): NotificationCompat.Builder

Supply a custom RemoteViews to use instead of the standard one.

open fun setContentInfo(@Nullable info: CharSequence): NotificationCompat.Builder

A small piece of additional information pertaining to this notification.

setContentIntent

open fun setContentIntent(@Nullable intent: PendingIntent): NotificationCompat.Builder

Supply a PendingIntent to send when the notification is clicked.

open fun setContentText(@Nullable text: CharSequence): NotificationCompat.Builder

Set the text (second row) of the notification, in a standard notification.

setContentTitle

open fun setContentTitle(@Nullable title: CharSequence): NotificationCompat.Builder

Set the title (first row) of the notification, in a standard notification.

setCustomBigContentView

open fun setCustomBigContentView(@Nullable contentView: RemoteViews): NotificationCompat.Builder

Supply custom RemoteViews to use instead of the platform template in the expanded form.

setCustomContentView

open fun setCustomContentView(@Nullable contentView: RemoteViews): NotificationCompat.Builder

Supply custom RemoteViews to use instead of the platform template.

setCustomHeadsUpContentView

open fun setCustomHeadsUpContentView(@Nullable contentView: RemoteViews): NotificationCompat.Builder

Supply custom RemoteViews to use instead of the platform template in the heads up dialog.

open fun setDefaults(defaults: Int): NotificationCompat.Builder

Set the default notification options that will be used.

setDeleteIntent

open fun setDeleteIntent(@Nullable intent: PendingIntent): NotificationCompat.Builder

Supply a PendingIntent to send when the notification is cleared by the user directly from the notification panel.

open fun setExtras(@Nullable extras: Bundle): NotificationCompat.Builder

Set metadata for this notification.

setForegroundServiceBehavior

open fun setForegroundServiceBehavior(behavior: Int): NotificationCompat.Builder

Specify a desired visibility policy for a Notification associated with a foreground service.

setFullScreenIntent

open fun setFullScreenIntent(@Nullable intent: PendingIntent, highPriority: Boolean): NotificationCompat.Builder

An intent to launch instead of posting the notification to the status bar.

open fun setGroup(@Nullable groupKey: String): NotificationCompat.Builder

Set this notification to be part of a group of notifications sharing the same key.

setGroupAlertBehavior

open fun setGroupAlertBehavior(groupAlertBehavior: Int): NotificationCompat.Builder

Sets the group alert behavior for this notification.

setGroupSummary

open fun setGroupSummary(isGroupSummary: Boolean): NotificationCompat.Builder

Set this notification to be the group summary for a group of notifications.

open fun setLargeIcon(@Nullable icon: Bitmap): NotificationCompat.Builder

@RequiresApi(value = 23)

open fun setLargeIcon(@Nullable icon: Icon): NotificationCompat.Builder

Sets the large icon that is shown in the notification.

open fun setLights(@ColorInt argb: Int, onMs: Int, offMs: Int): NotificationCompat.Builder

Set the argb value that you would like the LED on the device to blink, as well as the rate.

open fun setLocalOnly(b: Boolean): NotificationCompat.Builder

Set whether or not this notification is only relevant to the current device.

open fun setLocusId(@Nullable locusId: LocusIdCompat): NotificationCompat.Builder

Sets the LocusIdCompat associated with this notification.

setNotificationSilent

open fun ~~setNotificationSilent~~(): NotificationCompat.Builder

Silences this instance of the notification, regardless of the sounds or vibrations set on the notification or notification channel.

open fun setNumber(number: Int): NotificationCompat.Builder

Sets the number of items this notification represents.

open fun setOngoing(ongoing: Boolean): NotificationCompat.Builder

Set whether this is an ongoing notification.

setOnlyAlertOnce

open fun setOnlyAlertOnce(onlyAlertOnce: Boolean): NotificationCompat.Builder

Set this flag if you would only like the sound, vibrate and ticker to be played if the notification is not already showing.

open fun setPriority(pri: Int): NotificationCompat.Builder

Set the relative priority for this notification.

open fun setProgress(max: Int, progress: Int, indeterminate: Boolean): NotificationCompat.Builder

Set the progress this notification represents, which may be represented as a android.widget.ProgressBar.

setPublicVersion

open fun setPublicVersion(@Nullable n: Notification): NotificationCompat.Builder

Supply a replacement Notification whose contents should be shown in insecure contexts (i.e.

setRemoteInputHistory

open fun setRemoteInputHistory(@Nullable text: Array<CharSequence>): NotificationCompat.Builder

Set the remote input history.

setSettingsText

open fun setSettingsText(@Nullable text: CharSequence): NotificationCompat.Builder

Provides text that will appear as a link to your application's settings.

open fun setShortcutId(@Nullable shortcutId: String): NotificationCompat.Builder

From Android 11, messaging notifications (those that use MessagingStyle) that use this method to link to a published long-lived sharing shortcut may appear in a dedicated Conversation section of the shade and may show configuration options that are unique to conversations.

setShortcutInfo

open fun setShortcutInfo(@Nullable shortcutInfo: ShortcutInfoCompat): NotificationCompat.Builder

Populates this notification with given ShortcutInfoCompat.

open fun setShowWhen(show: Boolean): NotificationCompat.Builder

Control whether the timestamp set with setWhen is shown in the content view.

open fun setSilent(silent: Boolean): NotificationCompat.Builder

If true, silences this instance of the notification, regardless of the sounds or vibrations set on the notification or notification channel.

@RequiresApi(value = 23)

open fun setSmallIcon(@NonNull icon: IconCompat): NotificationCompat.Builder

open fun setSmallIcon(icon: Int): NotificationCompat.Builder

Set the small icon to use in the notification layouts.

open fun setSmallIcon(icon: Int, level: Int): NotificationCompat.Builder

A variant of setSmallIcon(int) that takes an additional level parameter for when the icon is a LevelListDrawable.

open fun setSortKey(@Nullable sortKey: String): NotificationCompat.Builder

Set a sort key that orders this notification among other notifications from the same package.

open fun setSound(@Nullable sound: Uri): NotificationCompat.Builder

open fun setSound(@Nullable sound: Uri, streamType: Int): NotificationCompat.Builder

Set the sound to play.

open fun setStyle(@Nullable style: NotificationCompat.Style): NotificationCompat.Builder

Add a rich notification style to be applied at build time.

open fun setSubText(@Nullable text: CharSequence): NotificationCompat.Builder

This provides some additional information that is displayed in the notification.

open fun setTicker(@Nullable tickerText: CharSequence): NotificationCompat.Builder

open fun ~~setTicker~~(@Nullable tickerText: CharSequence, @Nullable views: RemoteViews): NotificationCompat.Builder

Sets the "ticker" text which is sent to accessibility services.

setTimeoutAfter

open fun setTimeoutAfter(durationMs: Long): NotificationCompat.Builder

Specifies the time at which this notification should be canceled, if it is not already canceled.

setUsesChronometer

open fun setUsesChronometer(b: Boolean): NotificationCompat.Builder

Show the when field as a stopwatch.

open fun setVibrate(@Nullable pattern: Array<Long>): NotificationCompat.Builder

Set the vibration pattern to use.

open fun setVisibility(visibility: Int): NotificationCompat.Builder

Sets visibility.

open fun setWhen(when: Long): NotificationCompat.Builder

Set the time that the event occurred.